org.springframework.jms.config

Class JmsListenerEndpointRegistrar

java.lang.Object

org.springframework.jms.config.JmsListenerEndpointRegistrar

All Implemented Interfaces:

Aware, BeanFactoryAware, InitializingBean

public class JmsListenerEndpointRegistrar
extends java.lang.Object
implements BeanFactoryAware, InitializingBean

Helper bean for registering JmsListenerEndpoint with a JmsListenerEndpointRegistry.

Since:

4.1

Author:

Stephane Nicoll, Juergen Hoeller

See Also:

JmsListenerConfigurer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	JmsListenerEndpointRegistrar.JmsListenerEndpointDescriptor

Field Summary

Fields

Modifier and Type	Field and Description
private BeanFactory	beanFactory
private JmsListenerContainerFactory<?>	containerFactory
private java.lang.String	containerFactoryBeanName
private java.util.List<JmsListenerEndpointRegistrar.JmsListenerEndpointDescriptor>	endpointDescriptors
private JmsListenerEndpointRegistry	endpointRegistry
private MessageHandlerMethodFactory	messageHandlerMethodFactory

Constructor Summary

Constructors

Constructor and Description
JmsListenerEndpointRegistrar()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet() Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
JmsListenerEndpointRegistry	getEndpointRegistry() Return the JmsListenerEndpointRegistry instance for this registrar, may be null.
MessageHandlerMethodFactory	getMessageHandlerMethodFactory() Return the custom MessageHandlerMethodFactory to use, if any.
protected void	registerAllEndpoints()
void	registerEndpoint(JmsListenerEndpoint endpoint) Register a new JmsListenerEndpoint using the default JmsListenerContainerFactory to create the underlying container.
void	registerEndpoint(JmsListenerEndpoint endpoint, JmsListenerContainerFactory<?> factory) Register a new JmsListenerEndpoint alongside the JmsListenerContainerFactory to use to create the underlying container.
private JmsListenerContainerFactory<?>	resolveContainerFactory(JmsListenerEndpointRegistrar.JmsListenerEndpointDescriptor descriptor)
void	setBeanFactory(BeanFactory beanFactory) A BeanFactory only needs to be available in conjunction with setContainerFactoryBeanName(java.lang.String).
void	setContainerFactory(JmsListenerContainerFactory<?> containerFactory) Set the JmsListenerContainerFactory to use in case a JmsListenerEndpoint is registered with a null container factory.
void	setContainerFactoryBeanName(java.lang.String containerFactoryBeanName) Set the bean name of the JmsListenerContainerFactory to use in case a JmsListenerEndpoint is registered with a null container factory.
void	setEndpointRegistry(JmsListenerEndpointRegistry endpointRegistry) Set the JmsListenerEndpointRegistry instance to use.
void	setMessageHandlerMethodFactory(MessageHandlerMethodFactory messageHandlerMethodFactory) Set the MessageHandlerMethodFactory to use to configure the message listener responsible to serve an endpoint detected by this processor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

endpointRegistry

private JmsListenerEndpointRegistry endpointRegistry

messageHandlerMethodFactory

private MessageHandlerMethodFactory messageHandlerMethodFactory

containerFactory

private JmsListenerContainerFactory<?> containerFactory

containerFactoryBeanName

private java.lang.String containerFactoryBeanName

beanFactory

private BeanFactory beanFactory

endpointDescriptors

private final java.util.List<JmsListenerEndpointRegistrar.JmsListenerEndpointDescriptor> endpointDescriptors

Constructor Detail

JmsListenerEndpointRegistrar

public JmsListenerEndpointRegistrar()

Method Detail

setEndpointRegistry

public void setEndpointRegistry(JmsListenerEndpointRegistry endpointRegistry)

Set the JmsListenerEndpointRegistry instance to use.

getEndpointRegistry

public JmsListenerEndpointRegistry getEndpointRegistry()

Return the JmsListenerEndpointRegistry instance for this registrar, may be null.

setMessageHandlerMethodFactory

public void setMessageHandlerMethodFactory(MessageHandlerMethodFactory messageHandlerMethodFactory)

Set the MessageHandlerMethodFactory to use to configure the message listener responsible to serve an endpoint detected by this processor.

By default, DefaultMessageHandlerMethodFactory is used and it can be configured further to support additional method arguments or to customize conversion and validation support. See DefaultMessageHandlerMethodFactory javadoc for more details.

getMessageHandlerMethodFactory

public MessageHandlerMethodFactory getMessageHandlerMethodFactory()

Return the custom MessageHandlerMethodFactory to use, if any.

setContainerFactory

public void setContainerFactory(JmsListenerContainerFactory<?> containerFactory)

Set the JmsListenerContainerFactory to use in case a JmsListenerEndpoint is registered with a null container factory.

Alternatively, the bean name of the JmsListenerContainerFactory to use can be specified for a lazy lookup, see setContainerFactoryBeanName(java.lang.String).

setContainerFactoryBeanName

public void setContainerFactoryBeanName(java.lang.String containerFactoryBeanName)

Set the bean name of the JmsListenerContainerFactory to use in case a JmsListenerEndpoint is registered with a null container factory. Alternatively, the container factory instance can be registered directly: see setContainerFactory(JmsListenerContainerFactory).

See Also:

setBeanFactory(org.springframework.beans.factory.BeanFactory)

setBeanFactory

public void setBeanFactory(BeanFactory beanFactory)

A BeanFactory only needs to be available in conjunction with setContainerFactoryBeanName(java.lang.String).

Specified by:

setBeanFactory in interface BeanFactoryAware

Parameters:

beanFactory - owning BeanFactory (never null). The bean can immediately call methods on the factory.

See Also:

BeanInitializationException

afterPropertiesSet

public void afterPropertiesSet()

Description copied from interface: InitializingBean

Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).

This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.

Specified by:

afterPropertiesSet in interface InitializingBean

registerAllEndpoints

protected void registerAllEndpoints()

resolveContainerFactory

private JmsListenerContainerFactory<?> resolveContainerFactory(JmsListenerEndpointRegistrar.JmsListenerEndpointDescriptor descriptor)

registerEndpoint

public void registerEndpoint(JmsListenerEndpoint endpoint,
                             JmsListenerContainerFactory<?> factory)

Register a new JmsListenerEndpoint alongside the JmsListenerContainerFactory to use to create the underlying container.

The factory may be null if the default factory has to be used for that endpoint.

registerEndpoint

public void registerEndpoint(JmsListenerEndpoint endpoint)

Register a new JmsListenerEndpoint using the default JmsListenerContainerFactory to create the underlying container.

See Also:

setContainerFactory(JmsListenerContainerFactory), registerEndpoint(JmsListenerEndpoint, JmsListenerContainerFactory)